<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilloader: xloader_client.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilloader
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xloader__client_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xloader_client.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the implementation of the client interface functions. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00  dd   01/09/24 Initial release
      har  03/05/24 Fixed doxygen warnings
      pre  08/22/24 Added XLoader_CfiSelectiveReadback, XLoader_InputSlrIndex functions
      pre  10/26/24 Removed XLoader_LoadReadBackPdi API</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabd3e6b81339122b2fc4ecad981f1a9cd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gabd3e6b81339122b2fc4ecad981f1a9cd">XLOADER_ADDR_HIGH_SHIFT</a>&#160;&#160;&#160;(32U)</td></tr>
<tr class="memdesc:gabd3e6b81339122b2fc4ecad981f1a9cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift value to get higher 32 bit address.  <a href="group__xloader__client__apis.html#gabd3e6b81339122b2fc4ecad981f1a9cd">More...</a><br/></td></tr>
<tr class="separator:gabd3e6b81339122b2fc4ecad981f1a9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade1f63d75c755d641d0db91afbaa3303"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gade1f63d75c755d641d0db91afbaa3303">XLOADER_MSB_MASK</a>&#160;&#160;&#160;(0x80000000)</td></tr>
<tr class="memdesc:gade1f63d75c755d641d0db91afbaa3303"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for MSB bit.  <a href="group__xloader__client__apis.html#gade1f63d75c755d641d0db91afbaa3303">More...</a><br/></td></tr>
<tr class="separator:gade1f63d75c755d641d0db91afbaa3303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ff0ecf425161c5cd6d009e4c0c7c5b3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga1ff0ecf425161c5cd6d009e4c0c7c5b3">XLOADER_SELREADBACK_ROW_START_POS</a>&#160;&#160;&#160;(23U)</td></tr>
<tr class="memdesc:ga1ff0ecf425161c5cd6d009e4c0c7c5b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Row field start bit position.  <a href="group__xloader__client__apis.html#ga1ff0ecf425161c5cd6d009e4c0c7c5b3">More...</a><br/></td></tr>
<tr class="separator:ga1ff0ecf425161c5cd6d009e4c0c7c5b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga38517dc1fcd808ed89bb3ff902350b86"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga38517dc1fcd808ed89bb3ff902350b86">XLOADER_SELREADBACK_BLKTYPE_START_POS</a>&#160;&#160;&#160;(20U)</td></tr>
<tr class="memdesc:ga38517dc1fcd808ed89bb3ff902350b86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block type field start bit position.  <a href="group__xloader__client__apis.html#ga38517dc1fcd808ed89bb3ff902350b86">More...</a><br/></td></tr>
<tr class="separator:ga38517dc1fcd808ed89bb3ff902350b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa39ad3db38cb7d477accd3ed0534c201"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaa39ad3db38cb7d477accd3ed0534c201">XLOADER_SELREADBACK_ROW_MASK</a>&#160;&#160;&#160;(0x7800000U)</td></tr>
<tr class="memdesc:gaa39ad3db38cb7d477accd3ed0534c201"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for row.  <a href="group__xloader__client__apis.html#gaa39ad3db38cb7d477accd3ed0534c201">More...</a><br/></td></tr>
<tr class="separator:gaa39ad3db38cb7d477accd3ed0534c201"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5f713bcb041139fafb878896da388a2f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga5f713bcb041139fafb878896da388a2f">XLOADER_SLEREADBACK_BLKTYPE_MASK</a>&#160;&#160;&#160;(0X700000U)</td></tr>
<tr class="memdesc:ga5f713bcb041139fafb878896da388a2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for block type.  <a href="group__xloader__client__apis.html#ga5f713bcb041139fafb878896da388a2f">More...</a><br/></td></tr>
<tr class="separator:ga5f713bcb041139fafb878896da388a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c9d32fc15da21624de8de627d96a867"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga2c9d32fc15da21624de8de627d96a867">XLOADER_SLEREADBACK_FRAMEADDR_MASK</a>&#160;&#160;&#160;(0xFFFFFU)</td></tr>
<tr class="memdesc:ga2c9d32fc15da21624de8de627d96a867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for frame address.  <a href="group__xloader__client__apis.html#ga2c9d32fc15da21624de8de627d96a867">More...</a><br/></td></tr>
<tr class="separator:ga2c9d32fc15da21624de8de627d96a867"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa46059a11b24bca179cdb16cec9d5e03"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaa46059a11b24bca179cdb16cec9d5e03">XLoader_LoadPartialPdi</a> (XLoader_ClientInstance *InstancePtr, <a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a> PdiSrc, u64 PdiAddr, u32 *PlmErrStatus)</td></tr>
<tr class="memdesc:gaa46059a11b24bca179cdb16cec9d5e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to provides PDI execution.  <a href="group__xloader__client__apis.html#gaa46059a11b24bca179cdb16cec9d5e03">More...</a><br/></td></tr>
<tr class="separator:gaa46059a11b24bca179cdb16cec9d5e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05ffa5255e46703e2b3762b3841104bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga05ffa5255e46703e2b3762b3841104bc">XLoader_LoadImage</a> (XLoader_ClientInstance *InstancePtr, u32 NodeId, u32 FunctionId)</td></tr>
<tr class="memdesc:ga05ffa5255e46703e2b3762b3841104bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Load image.  <a href="group__xloader__client__apis.html#ga05ffa5255e46703e2b3762b3841104bc">More...</a><br/></td></tr>
<tr class="separator:ga05ffa5255e46703e2b3762b3841104bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac98e60c304d3cc096b362373ae9eb29e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gac98e60c304d3cc096b362373ae9eb29e">XLoader_GetImageInfo</a> (XLoader_ClientInstance *InstancePtr, u32 NodeId, XLoader_ImageInfo *ImageInfo)</td></tr>
<tr class="memdesc:gac98e60c304d3cc096b362373ae9eb29e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get image information.  <a href="group__xloader__client__apis.html#gac98e60c304d3cc096b362373ae9eb29e">More...</a><br/></td></tr>
<tr class="separator:gac98e60c304d3cc096b362373ae9eb29e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4737ad97892352c05d25dc687aa87a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gac4737ad97892352c05d25dc687aa87a1">XLoader_GetImageInfoList</a> (XLoader_ClientInstance *InstancePtr, u64 Buff_Addr, u32 Maxsize, u32 *NumEntries)</td></tr>
<tr class="memdesc:gac4737ad97892352c05d25dc687aa87a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to gets ImageInfo Table.  <a href="group__xloader__client__apis.html#gac4737ad97892352c05d25dc687aa87a1">More...</a><br/></td></tr>
<tr class="separator:gac4737ad97892352c05d25dc687aa87a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e571b298df7278911edeb130a4917c6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga6e571b298df7278911edeb130a4917c6">XLoader_ExtractMetaheader</a> (XLoader_ClientInstance *InstancePtr, u64 PdiSrcAddr, u64 DestBuffAddr, u32 DestBuffSize)</td></tr>
<tr class="memdesc:ga6e571b298df7278911edeb130a4917c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Extract meta header.  <a href="group__xloader__client__apis.html#ga6e571b298df7278911edeb130a4917c6">More...</a><br/></td></tr>
<tr class="separator:ga6e571b298df7278911edeb130a4917c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29c0d281ad005ea2b4a987b8c1008694"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga29c0d281ad005ea2b4a987b8c1008694">XLoader_UpdateMultiboot</a> (XLoader_ClientInstance *InstancePtr, <a class="el" href="xloader__client_8h.html#a80466c7a413948d606d725278a61df96">XLoader_PdiSrc</a> BootMode, <a class="el" href="xloader__client_8h.html#a3bfb7027b81951f1f5d157b1de5ce15c">XLoader_FlashType</a> Type, u32 ImageLocation)</td></tr>
<tr class="memdesc:ga29c0d281ad005ea2b4a987b8c1008694"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to update multiboot.  <a href="group__xloader__client__apis.html#ga29c0d281ad005ea2b4a987b8c1008694">More...</a><br/></td></tr>
<tr class="separator:ga29c0d281ad005ea2b4a987b8c1008694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63d94db8c3d206242d0527631c38c5fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga63d94db8c3d206242d0527631c38c5fa">XLoader_AddImageStorePdi</a> (XLoader_ClientInstance *InstancePtr, u32 PdiId, const u64 PdiAddr, u32 PdiSize)</td></tr>
<tr class="memdesc:ga63d94db8c3d206242d0527631c38c5fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to add Image store pdi.  <a href="group__xloader__client__apis.html#ga63d94db8c3d206242d0527631c38c5fa">More...</a><br/></td></tr>
<tr class="separator:ga63d94db8c3d206242d0527631c38c5fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga2027ee38324a120aa3f23eb6a1f3476f">XLoader_RemoveImageStorePdi</a> (XLoader_ClientInstance *InstancePtr, u32 PdiId)</td></tr>
<tr class="memdesc:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to remove Image store pdi.  <a href="group__xloader__client__apis.html#ga2027ee38324a120aa3f23eb6a1f3476f">More...</a><br/></td></tr>
<tr class="separator:ga2027ee38324a120aa3f23eb6a1f3476f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaf07025194b841bfa9aa96bdb87cb48c8">XLoader_GetATFHandOffParams</a> (XLoader_ClientInstance *InstancePtr, u64 BuffAddr, u32 Size, u32 *BufferSize)</td></tr>
<tr class="memdesc:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get ATF Handoff parameters.  <a href="group__xloader__client__apis.html#gaf07025194b841bfa9aa96bdb87cb48c8">More...</a><br/></td></tr>
<tr class="separator:gaf07025194b841bfa9aa96bdb87cb48c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#gaabb2d5baeb7ebd06f2743edc48b28674">XLoader_CfiSelectiveReadback</a> (XLoader_ClientInstance *InstancePtr, XLoader_CfiSelReadbackParams *SelectiveReadbackPtr)</td></tr>
<tr class="memdesc:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to read selective frames from configuration memory.  <a href="group__xloader__client__apis.html#gaabb2d5baeb7ebd06f2743edc48b28674">More...</a><br/></td></tr>
<tr class="separator:gaabb2d5baeb7ebd06f2743edc48b28674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga048d2ad178b4c29a0f491b49f9e5788f">XLoader_InputSlrIndex</a> (XLoader_ClientInstance *InstancePtr, u32 SlrIndex)</td></tr>
<tr class="memdesc:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the SLR Index.  <a href="group__xloader__client__apis.html#ga048d2ad178b4c29a0f491b49f9e5788f">More...</a><br/></td></tr>
<tr class="separator:ga048d2ad178b4c29a0f491b49f9e5788f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">XLoader_GetOptionalData</a> (XLoader_ClientInstance *InstancePtr, const XLoader_OptionalDataInfo *OptionalDataInfo, u64 DestAddr, u32 *DestSize)</td></tr>
<tr class="memdesc:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get optional data from the PDI available in DDR or Image Store.  <a href="group__xloader__client__apis.html#ga8960e12865539b0b9a6c2e5f6a705ed7">More...</a><br/></td></tr>
<tr class="separator:ga8960e12865539b0b9a6c2e5f6a705ed7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
